FHIR © HL7.org  |  FHIRsmith 4.0.1  |  Server Home  |  XIG Home  |  XIG Stats  | 

FHIR IG analytics

Packageau.digitalhealth.cda.schema
Resource TypeStructureDefinition
IdStructureDefinition-Author.json
FHIR VersionR5
Sourcehttps://build.fhir.org/ig/AuDigitalHealth/cda-au-schema/StructureDefinition-Author.html
URLhttp://hl7.org/cda/stds/core/StructureDefinition/Author
Version1.0.1
Statusactive
Date2025-12-04T21:33:04+00:00
NameAuthor
TitleAuthor (CDA Class)
Realmau
Authoritynational
DescriptionRepresents the humans and/or machines that authored the document. In some cases, the role or function of the author is inherent in the ClinicalDocument.code, such as where ClinicalDocument.code is "Medical Student Progress Note". The role of the author can also be recorded in the Author.functionCode or AssignedAuthor.code attribute. If either of these attributes is included, they should be equivalent to or further specialize the role inherent in the ClinicalDocument.code (such as where the ClinicalDocument.code is simply "Physician Progress Note" and the value of Author.functionCode is "rounding physician"), and shall not conflict with the role inherent in the ClinicalDocument.code, as such a conflict would constitute an ambiguous situation.
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author
Kindlogical

Resources that use this resource

StructureDefinition
au.digitalhealth.cda.schema#currentActAct (CDA Class)
au.digitalhealth.cda.schema#currentClinicalDocumentClinicalDocument (CDA Class)
au.digitalhealth.cda.schema#currentEncounterEncounter (CDA Class)
au.digitalhealth.cda.schema#currentObservationObservation (CDA Class)
au.digitalhealth.cda.schema#currentObservationMediaObservationMedia (CDA Class)
au.digitalhealth.cda.schema#currentOrganizerOrganizer (CDA Class)
au.digitalhealth.cda.schema#currentProcedureProcedure (CDA Class)
au.digitalhealth.cda.schema#currentRegionOfInterestRegionOfInterest (CDA Class)
au.digitalhealth.cda.schema#currentSectionSection (CDA Class)
au.digitalhealth.cda.schema#currentSubstanceAdministrationSubstanceAdministration (CDA Class)
au.digitalhealth.cda.schema#currentSupplySupply (CDA Class)
hl7.cda.us.ccda#currentAdvanceDirectiveExistenceObservationAdvance Directive Existence Observation
hl7.cda.us.ccda#currentAdvanceDirectiveObservationAdvance Directive Observation
hl7.cda.us.ccda#currentAdvanceDirectiveOrganizerAdvance Directive Organizer (deprecated)
hl7.cda.us.ccda#currentAllergyConcernActAllergy Concern Act
hl7.cda.us.ccda#currentAuthorParticipationAuthor Participation
hl7.cda.us.ccda#currentAverageBloodPressureOrganizerAverage Blood Pressure Organizer
hl7.cda.us.ccda#currentCarePlanActCare Plan Act
hl7.cda.us.ccda#currentCareTeamOrganizerCare Team Organizer
hl7.cda.us.ccda#currentCommentActivityComment Activity
hl7.cda.us.ccda#currentDisabilityStatusObservationDisability Status Observation
hl7.cda.us.ccda#currentFunctionalStatusObservationFunctional Status Observation
hl7.cda.us.ccda#currentFunctionalStatusOrganizerFunctional Status Organizer
hl7.cda.us.ccda#currentGoalObservationGoal Observation
hl7.cda.us.ccda#currentHandoffCommunicationParticipantsHandoff Communication Participants
hl7.cda.us.ccda#currentHealthConcernActHealth Concern Act
hl7.cda.us.ccda#currentImmunizationActivityImmunization Activity
hl7.cda.us.ccda#currentInterventionActIntervention Act
hl7.cda.us.ccda#currentMedicationActivityMedication Activity
hl7.cda.us.ccda#currentMentalStatusObservationMental Status Observation
hl7.cda.us.ccda#currentNoteActivityNote Activity
hl7.cda.us.ccda#currentNutritionAssessmentNutrition Assessment
hl7.cda.us.ccda#currentOutcomeObservationOutcome Observation
hl7.cda.us.ccda#currentPlannedCoveragePlanned Coverage
hl7.cda.us.ccda#currentPlannedEncounterPlanned Encounter
hl7.cda.us.ccda#currentPlannedImmunizationActivityPlanned Immunization Activity
hl7.cda.us.ccda#currentPlannedInterventionActPlanned Intervention Act
hl7.cda.us.ccda#currentPlannedMedicationActivityPlanned Medication Activity
hl7.cda.us.ccda#currentPlannedProcedurePlanned Procedure
hl7.cda.us.ccda#currentPlannedSupplyPlanned Supply
hl7.cda.us.ccda#currentPriorityPreferencePriority Preference
hl7.cda.us.ccda#currentProblemConcernActProblem Concern Act
hl7.cda.us.ccda#currentProblemObservationProblem Observation
hl7.cda.us.ccda#currentProcedureActivityProcedureProcedure Activity Procedure
hl7.cda.us.ccda#currentProvenanceAuthorParticipationProvenance - Author Participation
hl7.cda.us.ccda#currentReferralActReferral Act
hl7.cda.us.ccda#currentResultObservationResult Observation
hl7.cda.us.ccda#currentResultOrganizerResult Organizer
hl7.cda.us.ccda#currentRiskConcernActRisk Concern Act
hl7.cda.us.ccda#currentSelfCareActivitiesADLandIADLSelf-Care Activities (ADL and IADL)
hl7.cda.us.ccda#currentSensoryStatusSensory Status
hl7.cda.us.ccda#currentSexParameterForClinicalUseObservationSex Parameter For Clinical Use Observation
hl7.cda.us.ccda#currentSmokingStatusMeaningfulUseSmoking Status - Meaningful Use (Deprecated)
hl7.cda.us.ccda#currentSocialHistoryObservationSocial History Observation
hl7.cda.us.ccda#currentSubstanceOrDeviceAllergyIntoleranceObservationSubstance or Device Allergy - Intolerance Observation
hl7.cda.us.ccda#currentTobaccoUseTobacco Use (Deprecated)
hl7.cda.us.ccda#currentVitalSignObservationVital Sign Observation
hl7.cda.us.ccda#currentVitalSignsOrganizerVital Signs Organizer

Resources that this resource uses

StructureDefinition
au.digitalhealth.cda.schema#currentAssignedAuthorAssignedAuthor (CDA Class)
au.digitalhealth.cda.schema#currentCECE: CodedWithEquivalents (V3 Data Type)
au.digitalhealth.cda.schema#currentInfrastructureRootInfrastructureRoot (Base Type for all CDA Classes)
au.digitalhealth.cda.schema#currentTSTS: PointInTime (V3 Data Type)
au.digitalhealth.cda.schema#currentcs-simplecs: Coded Simple Value
ValueSet
au.digitalhealth.cda.schema#currentCDAContextControlCDAContextControl
au.digitalhealth.cda.schema#currentCDAParticipationTypeCDAParticipationType

Narrative

Note: links and images are rebased to the (stated) source

Represents the humans and/or machines that authored the document.

In some cases, the role or function of the author is inherent in the ClinicalDocument.code, such as where ClinicalDocument.code is "Medical Student Progress Note". The role of the author can also be recorded in the Author.functionCode or AssignedAuthor.code attribute. If either of these attributes is included, they should be equivalent to or further specialize the role inherent in the ClinicalDocument.code (such as where the ClinicalDocument.code is simply "Physician Progress Note" and the value of Author.functionCode is "rounding physician"), and shall not conflict with the role inherent in the ClinicalDocument.code, as such a conflict would constitute an ambiguous situation.


Source1

{
  "resourceType": "StructureDefinition",
  "id": "Author",
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/logical-target",
      "_valueBoolean": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
            "valueCode": "not-applicable"
          }
        ]
      }
    },
    {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
      "valueUri": "urn:hl7-org:v3"
    },
    {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
      "valueString": "author"
    },
    {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/logical-container",
      "valueUri": "http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument"
    },
    {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/type-profile-style",
      "valueCode": "cda"
    }
  ],
  "url": "http://hl7.org/cda/stds/core/StructureDefinition/Author",
  "version": "1.0.1",
  "name": "Author",
  "title": "Author (CDA Class)",
  "status": "active",
  "experimental": false,
  "date": "2025-12-04T21:33:04+00:00",
  "publisher": "HL7",
  "description": "Represents the humans and/or machines that authored the document. In some cases, the role or function of the author is inherent in the ClinicalDocument.code, such as where ClinicalDocument.code is \"Medical Student Progress Note\". The role of the author can also be recorded in the Author.functionCode or AssignedAuthor.code attribute. If either of these attributes is included, they should be equivalent to or further specialize the role inherent in the ClinicalDocument.code (such as where the ClinicalDocument.code is simply \"Physician Progress Note\" and the value of Author.functionCode is \"rounding physician\"), and shall not conflict with the role inherent in the ClinicalDocument.code, as such a conflict would constitute an ambiguous situation.",
  "fhirVersion": "5.0.0",
  "mapping": [
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM Mapping"
    }
  ],
  "kind": "logical",
  "abstract": false,
  "type": "http://hl7.org/cda/stds/core/StructureDefinition/Author",
  "baseDefinition": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot",
  "derivation": "specialization",
  "snapshot": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
        "valueString": "1.0.1"
      }
    ],
    "element": [
      {
        "id": "Author",
        "path": "Author",
        "short": "Base for all types and resources",
        "definition": "Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "Base",
          "min": 0,
          "max": "*"
        },
        "isModifier": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "Author.nullFlavor",
        "path": "Author.nullFlavor",
        "representation": [
          "xmlAttr"
        ],
        "label": "Exceptional Value Detail",
        "definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "ANY.nullFlavor",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "code",
            "profile": [
              "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
            ]
          }
        ],
        "binding": {
          "strength": "required",
          "valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
        }
      },
      {
        "id": "Author.realmCode",
        "path": "Author.realmCode",
        "definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question",
        "min": 0,
        "max": "*",
        "base": {
          "path": "InfrastructureRoot.realmCode",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
          }
        ]
      },
      {
        "id": "Author.typeId",
        "path": "Author.typeId",
        "definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "InfrastructureRoot.typeId",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
          }
        ],
        "constraint": [
          {
            "key": "II-1",
            "severity": "error",
            "human": "An II instance must have either a root or an nullFlavor.",
            "expression": "root.exists() or nullFlavor.exists()",
            "source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
          }
        ]
      },
      {
        "id": "Author.typeId.nullFlavor",
        "path": "Author.typeId.nullFlavor",
        "representation": [
          "xmlAttr"
        ],
        "label": "Exceptional Value Detail",
        "definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "ANY.nullFlavor",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "code",
            "profile": [
              "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
            ]
          }
        ],
        "binding": {
          "strength": "required",
          "valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
        }
      },
      {
        "id": "Author.typeId.assigningAuthorityName",
        "path": "Author.typeId.assigningAuthorityName",
        "representation": [
          "xmlAttr"
        ],
        "label": "Assigning Authority Name",
        "definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "II.assigningAuthorityName",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "string",
            "profile": [
              "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
            ]
          }
        ]
      },
      {
        "id": "Author.typeId.displayable",
        "path": "Author.typeId.displayable",
        "representation": [
          "xmlAttr"
        ],
        "label": "Displayable",
        "definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
        "min": 0,
        "max": "1",
        "base": {
          "path": "II.displayable",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "boolean",
            "profile": [
              "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
            ]
          }
        ]
      },
      {
        "id": "Author.typeId.root",
        "path": "Author.typeId.root",
        "representation": [
          "xmlAttr"
        ],
        "label": "Root",
        "definition": "Identifies the type as an HL7 Registered model",
        "min": 1,
        "max": "1",
        "base": {
          "path": "II.root",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "string",
            "profile": [
              "http://hl7.org/cda/stds/core/StructureDefinition/oid",
              "http://hl7.org/cda/stds/core/StructureDefinition/uuid",
              "http://hl7.org/cda/stds/core/StructureDefinition/ruid"
            ]
          }
        ],
        "fixedString": "2.16.840.1.113883.1.3"
      },
      {
        "id": "Author.typeId.extension",
        "path": "Author.typeId.extension",
        "representation": [
          "xmlAttr"
        ],
        "label": "Extension",
        "definition": "A character string as a unique identifier within the scope of the identifier root.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "II.extension",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "string",
            "profile": [
              "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
            ]
          }
        ]
      },
      {
        "id": "Author.templateId",
        "path": "Author.templateId",
        "definition": "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
        "min": 0,
        "max": "*",
        "base": {
          "path": "InfrastructureRoot.templateId",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
          }
        ]
      },
      {
        "id": "Author.typeCode",
        "path": "Author.typeCode",
        "representation": [
          "xmlAttr"
        ],
        "min": 0,
        "max": "1",
        "base": {
          "path": "Author.typeCode",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "code",
            "profile": [
              "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
            ]
          }
        ],
        "fixedCode": "AUT",
        "binding": {
          "strength": "required",
          "valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType"
        }
      },
      {
        "id": "Author.contextControlCode",
        "path": "Author.contextControlCode",
        "representation": [
          "xmlAttr"
        ],
        "min": 0,
        "max": "1",
        "base": {
          "path": "Author.contextControlCode",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "code",
            "profile": [
              "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
            ]
          }
        ],
        "fixedCode": "OP",
        "binding": {
          "strength": "required",
          "valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAContextControl"
        }
      },
      {
        "id": "Author.functionCode",
        "path": "Author.functionCode",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Author.functionCode",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
          }
        ]
      },
      {
        "id": "Author.time",
        "path": "Author.time",
        "min": 1,
        "max": "1",
        "base": {
          "path": "Author.time",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/TS"
          }
        ]
      },
      {
        "id": "Author.assignedAuthor",
        "path": "Author.assignedAuthor",
        "min": 1,
        "max": "1",
        "base": {
          "path": "Author.assignedAuthor",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/AssignedAuthor"
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "Author",
        "path": "Author",
        "min": 1,
        "max": "1"
      },
      {
        "id": "Author.typeCode",
        "path": "Author.typeCode",
        "representation": [
          "xmlAttr"
        ],
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "code",
            "profile": [
              "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
            ]
          }
        ],
        "fixedCode": "AUT",
        "binding": {
          "strength": "required",
          "valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType"
        }
      },
      {
        "id": "Author.contextControlCode",
        "path": "Author.contextControlCode",
        "representation": [
          "xmlAttr"
        ],
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "code",
            "profile": [
              "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
            ]
          }
        ],
        "fixedCode": "OP",
        "binding": {
          "strength": "required",
          "valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAContextControl"
        }
      },
      {
        "id": "Author.functionCode",
        "path": "Author.functionCode",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
          }
        ]
      },
      {
        "id": "Author.time",
        "path": "Author.time",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/TS"
          }
        ]
      },
      {
        "id": "Author.assignedAuthor",
        "path": "Author.assignedAuthor",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/AssignedAuthor"
          }
        ]
      }
    ]
  }
}